API Overview
Allxon Octo API adopts JSON-RPC 2.0 specification over WebSocket. To communicate with Allxon Agent, you need to create a WebSocket connection wss://localhost:55688 from the plugin. Then send/receive requests in the JSON format via the API.
note
Each API maximum payload size is 2 KB.
note
JSON-RPC batch is not supported.
Allxon Octo JSON RPC API
Here is a brief introduction to the API functionalities:
v2/notifyPluginUpdate
| Direction | Description |
|---|---|
| Plugin → Allxon Agent | The plugin initializes every card on Allxon Portal. You must call v2/notifyPluginUpdate API after the WebSocket connection is established. |
v2/notifyPluginCommand
| Direction | Description |
|---|---|
| Allxon Agent → Plugin | The plugin gets notified once the user triggers the command on Allxon Portal. |
v2/notifyPluginCommandAck
| Direction | Description |
|---|---|
| Plugin → Allxon Agent | After receiving v2/notifyPluginCommand, the plugin sends acknowledgement of the command back to Allxon Portal. |
v2/notifyPluginState
| Direction | Description |
|---|---|
| Plugin → Allxon Agent | The plugin updates the data the States card on the Allxon Portal States card. This functionality is typically designed for updating the current device states, e.g. network condition and power status. Allxon Portal only shows the latest data it receives and doesn’t reserve such data. |
v2/notifyPluginEvent
| Direction | Description |
|---|---|
| Plugin → Allxon Agent | The plugin updates the data on the Event card on Allxon Portal. The event types and triggers are predefined by the plugin. This functionality is typically used for device event updates, e.g. IO trigger event and user login event. Such data is reserved on Allxon Cloud for 90 days. |
v2/notifyPluginMetric
| Direction | Description |
|---|---|
| Plugin → Allxon Agent | The plugin updates data on the Charts card on the Portal. This functionality is typically designed for time-series data presented in a trend chart, e.g. device temperature. Such data is reserved on Allxon Cloud for 90 days. |
v2/notifyPluginAlert
| Direction | Description |
|---|---|
| Plugin → Allxon Agent | Alerts are predefined by the plugin. This functionality is typically designed for triggering Alerts configured on Allxon Portal and for pushing notifications to users by email, Webhook, LINE, etc. |
v2/notifyPluginAlarmUpdate
| Direction | Description |
|---|---|
| Allxon Agent → Plugin | When Alerts are set up on Allxon Portal, the plugin receives v2/notifyPluginAlarmUpdate to synchronize with the alert related settings. |
v2/notifyPluginConfigUpdate
| Direction | Description |
|---|---|
| Allxon Agent → Plugin | If Configs are set up on Allxon Portal, the plugin gets notified once it comes online. This functionality is typically designed for setting rules to automate device operations. |
tip
For more details, please refer to the API Reference.
API Sequence Flow
Here is an example of the API sequence flow:
- Connect to Allxon Agent by Websocket.
- Send
v2/notifyPluginUpdateto initialize cards on Allxon Portal. - Once the Alert Settings are updated, the plugin receives
v2/notifyPluginAlarmUpdateto apply the settings. - Once Configs are set up on Allxon Portal, the plugin receives
v2/notifyPluginConfigUpdateto apply the settings.